Docs
get https://gateway.iugu.com/api/v1/transactions/show/{payment_id}

Obter detalhes do pagamento

Recupera detalhes de um pagamento específico

Permissão necessária: gateway:transactions.show

Esta permissão deve constar como uma das ações permitidas para o app que faz a chamada. Isto pode ser feito através do GIA, ou então na edição do aplicativo. Em caso de dúvidas, clique aqui.

Request

Path variables

payment_id

Required

Type: string

ID do pagamento a ser consultado

Response

200

Detalhes do pagamento recuperados com sucesso

payment
Object

id
String

status
String

multi
Array of strings

success_ec
String

mcc
String

recurrent
Boolean

card_on_file
String

tid
String

nsu
String

authorization_code
String

amount_cents
Integer

refunded_amount_cents
Integer

cnpj
String

workspace_id
String

account_id
String

invoice_id
String

client_ref
String

credit_card_id
String

currency
String

installments
Integer

soft_descriptor
String

created_at
String

updated_at
String

transactions
Array of objects

function
String

success
Boolean

tid
String

nsu
String

arp
String

acquirer
Object

payment_id
String

status_code
String

acquirer_mac_code
String

status_description
String

request_status_code
String

request_status_description
String

card_on_file
String

amount_cents
Integer

commercial_enterprise
Object

id
String

name
String

number
String

acquirer
String

mcc
Object

id
String

code
String

description
String

created_at
String

anti_fraud
Array of objects

id
String

status
String

score
Integer

created_at
String

Example
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
{
  "payment": {
    "id": "<ID>",
    "status": "<STATUS>",
    "multi": [
      "<MULTI>"
    ],
    "success_ec": "<SUCCESS_EC>",
    "mcc": "<MCC>",
    "recurrent": "<RECURRENT>",
    "card_on_file": "<CARD_ON_FILE>",
    "tid": "<TID>",
    "nsu": "<NSU>",
    "authorization_code": "<AUTHORIZATION_CODE>",
    "amount_cents": "<AMOUNT_CENTS>",
    "refunded_amount_cents": "<REFUNDED_AMOUNT_CENTS>",
    "cnpj": "<CNPJ>",
    "workspace_id": "<WORKSPACE_ID>",
    "account_id": "<ACCOUNT_ID>",
    "invoice_id": "<INVOICE_ID>",
    "client_ref": "<CLIENT_REF>",
    "credit_card_id": "<CREDIT_CARD_ID>",
    "currency": "<CURRENCY>",
    "installments": "<INSTALLMENTS>",
    "soft_descriptor": "<SOFT_DESCRIPTOR>",
    "created_at": "<CREATED_AT>",
    "updated_at": "<UPDATED_AT>",
    "transactions": [
      {
        "function": "<FUNCTION>",
        "success": "<SUCCESS>",
        "tid": "<TID>",
        "nsu": "<NSU>",
        "arp": "<ARP>",
        "acquirer": {
          "payment_id": "<PAYMENT_ID>",
          "status_code": "<STATUS_CODE>",
          "acquirer_mac_code": "<ACQUIRER_MAC_CODE>",
          "status_description": "<STATUS_DESCRIPTION>",
          "request_status_code": "<REQUEST_STATUS_CODE>",
          "request_status_description": "<REQUEST_STATUS_DESCRIPTION>"
        },
        "card_on_file": "<CARD_ON_FILE>",
        "amount_cents": "<AMOUNT_CENTS>",
        "commercial_enterprise": {
          "id": "<ID>",
          "name": "<NAME>",
          "number": "<NUMBER>",
          "acquirer": "<ACQUIRER>",
          "mcc": {
            "id": "<ID>",
            "code": "<CODE>",
            "description": "<DESCRIPTION>"
          }
        },
        "created_at": "<CREATED_AT>"
      }
    ],
    "anti_fraud": [
      {
        "id": "<ID>",
        "status": "<STATUS>",
        "score": "<SCORE>",
        "created_at": "<CREATED_AT>"
      }
    ]
  }
}

401

Não autorizado - Token de autenticação inválido ou ausente

404

Pagamento não encontrado